Skip to content

wpcomsh: use APD for user token #45303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 23 commits into from
Oct 28, 2025
Merged

wpcomsh: use APD for user token #45303

merged 23 commits into from
Oct 28, 2025

Conversation

@bindlegirl
Copy link
Contributor

@bindlegirl bindlegirl commented Sep 25, 2025 •
edited
Loading

This PR adds support for connection owner tokens stored in APD. Tokens are stored in two parts (secret and email). The email is used to assemble a "normal" Jetpack token by extracting the local user ID from an email address.

Closes CONNECT-35

Proposed changes:

  • Adding two more options that are supported by external storage (master_user and user_tokens).
  • The APD handles only owner tokens so it injects the APD version of the token into the existing user_tokens array.
  • If a legacy token for the same user is found in db, the code deletes it to prevent any conflicts or confusion.
  • We don't insert the new token into db here. This is something we may or may not decide to do in future updates.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

https://linear.app/a8c/project/external-storage-for-connection-data-cd44d4d97124/overview

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Create a dev WoA site and break the connection if you can, I dare you 😄
  • Full instructions: 3961a-pb

@bindlegirl bindlegirl self-assigned this Sep 25, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Sep 25, 2025 •
edited
Loading

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (WordPress.com Site Helper), and enable the update/external-storage-user-connection branch.

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions
Copy link
Contributor

github-actions bot commented Sep 25, 2025 •
edited
Loading

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2)

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Sep 25, 2025
@jp-launch-control
Copy link

jp-launch-control bot commented Sep 25, 2025 •
edited
Loading

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report

@bindlegirl bindlegirl force-pushed the update/external-storage-user-connection branch from d06f3cd to e5c77f3 Compare September 30, 2025 15:15
@bindlegirl bindlegirl added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Sep 30, 2025
@bindlegirl bindlegirl removed the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Oct 23, 2025
@bindlegirl bindlegirl force-pushed the update/external-storage-user-connection branch from a3c6def to 1f1a83f Compare October 23, 2025 12:02
@bindlegirl bindlegirl requested a review from Copilot October 23, 2025 13:49
Copilot AI reviewed Oct 23, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR extends the Atomic Storage Provider to support user-level connection data from Atomic Persistent Data (APD), enabling full connection management for WordPress.com Atomic sites.

  • Adds support for master_user and user_tokens retrieval from external storage
  • Implements token validation logic to handle conflicts and orphaned tokens
  • Adds comprehensive test coverage for new functionality

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
projects/plugins/wpcomsh/connection/class-atomic-storage-provider.php Implements user token and master user retrieval with validation logic
projects/plugins/wpcomsh/tests/AtomicStorageProviderTest.php Adds comprehensive tests for new user token functionality
projects/plugins/wpcomsh/tests/lib/mocks/class-jetpack-options.php Updates mock to handle grouped options for testing
projects/plugins/wpcomsh/changelog/update-external-storage-user-connection Documents the feature addition

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@bindlegirl bindlegirl requested a review from a team October 24, 2025 10:42
@bindlegirl bindlegirl marked this pull request as ready for review October 24, 2025 10:42
@bindlegirl bindlegirl added [Status] Needs Review This PR is ready for review. and removed [Status] In Progress labels Oct 24, 2025
sergeymitr
sergeymitr reviewed Oct 24, 2025
View reviewed changes
Copy link
Contributor

@sergeymitr sergeymitr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just noticed a few things we might need to double check.

@bindlegirl bindlegirl force-pushed the update/external-storage-user-connection branch from f50f3d2 to aa3e166 Compare October 27, 2025 17:26
@bindlegirl bindlegirl requested review from a team and sergeymitr October 27, 2025 18:38
coder-karen
coder-karen reviewed Oct 28, 2025
View reviewed changes
Copy link
Contributor

@coder-karen coder-karen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for helping me test this one - I followed most steps except where it involved creating a new email in order to change email address on a WP account. Everything else tested as expected.
I'd leave a final review to @sergeymitr who has more knowledge here. Left a small test related question though :)

sergeymitr
sergeymitr approved these changes Oct 28, 2025
View reviewed changes
Copy link
Contributor

@sergeymitr sergeymitr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well, great job 👍

@sergeymitr sergeymitr added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review This PR is ready for review. labels Oct 28, 2025
@bindlegirl bindlegirl merged commit baab46a into trunk Oct 28, 2025
67 checks passed
@bindlegirl bindlegirl deleted the update/external-storage-user-connection branch October 28, 2025 18:04
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coder-karen coder-karen coder-karen left review comments

Copilot code review Copilot Copilot left review comments

@sergeymitr sergeymitr sergeymitr approved these changes

Assignees

@bindlegirl bindlegirl

Labels

[Plugin] Wpcomsh [Tests] Includes Tests [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bindlegirl @sergeymitr @coder-karen